Link Functions and Variables Documentation

Functions and Properties

Return Type	Function Information
`int`	`XLink's X position on the screen, in pixels. Float values passed to this will be cast to int.`
`int`	`YLink's Y position on the screen, in pixels. Float values passed to this will be cast to int.`
`int`	`ZLink's Z position on the screen, in pixels. Float values passed to this will be cast to int.`
`bool`	`InvisibleWhether Link is currently being draw to the screen. Set true to remove him from view.`
`bool`	`CollDetectionIf true, Link's collision detection with npcs and eweapons is currently turned off. This variable works on a different system to clocks and the level 4 cheat, so it will not necessarily return true if they are set.`
`int`	`JumpLink's upward velocity, in pixels. If negative, Link will fall. The downward acceleration of Gravity (in Init Data) modifies this value every frame.`
`int`	`SwordJinxThe time, in frames, until Link regains use of his sword. -1 signifies a permanent loss of the sword.`
`int`	`ItemJinxThe time, in frames, until Link regains use of his items. -1 signifies a permanent loss of his items.`
`int`	`DrunkThe time, in frames, that Link will be 'drunk'. If positive, the player's controls are randomly interfered with, causing Link to move erratically. This value is decremented once per frame. As the value of Drunk approaches 0 the intensity of the effect decreases.`
`int`	`DirThe direction Link is facing. Use the DIR_ constants in std.zh to set or compare this variable. Note: even though Link can move diagonally if the quest allows it, his sprite doesn't ever use any of the diagonal directions which are intended for enemies only.`
`int`	`HitDirThe direction Link should bounce in when he is hit. This is mostly useful for simulating getting hit by setting Link->Action to LA_GOTHURTLAND.`
`int`	`HPLink's current hitpoints, in 16ths of a heart.`
`int`	`MPLink's current amount of magic, in 32nds of a magic block.`
`int`	`MaxHPLink's maximum hitpoints, in 16ths of a heart.`
`int`	`MaxMPLink's maximum amount of magic, in 32nds of a magic block.`
`int`	`ActionLink's current action. Use the LA_ constants in std.zh to set or compare this value. The effect of writing to this field is currently undefined.`
`int`	`HeldItemThe item that Link is currently holding up; reading or setting this field is undefined if Link's action is not current a hold action. Use the I_ constants in std.zh to specify the item, or -1 to show no item. Setting HeldItem to values other than -1 or a valid item ID is undefined.`
`int`	`LadderXThe X position of Link's stepladder, or 0 if no ladder is onscreen. This is read-only; while setting it is not syntactically incorrect, it does nothing.`
`int`	`LadderYThe Y position of Link's stepladder, or 0 if no ladder is onscreen. This is read-only; while setting it is not syntactically incorrect, it does nothing. Input Functions * The following Input* boolean values return true if the player is pressing the corresponding button, analog stick, or key. Writing to this variable simulates the press or release of that referenced button, analog stick, or key.`
`bool`	`InputStartThe following Press* boolean values return true if the player activated the corresponding button, analog stick, or key this frame. Writing to this variable simulates the press or release of that referenced button, analog stick or keys input press state. */`
`bool`	`InputMapThe following Press* boolean values return true if the player activated the corresponding button, analog stick, or key this frame. Writing to this variable simulates the press or release of that referenced button, analog stick or keys input press state. */`
`bool`	`InputUpThe following Press* boolean values return true if the player activated the corresponding button, analog stick, or key this frame. Writing to this variable simulates the press or release of that referenced button, analog stick or keys input press state. */ bool InputStart;`
`bool`	`InputDownThe following Press* boolean values return true if the player activated the corresponding button, analog stick, or key this frame. Writing to this variable simulates the press or release of that referenced button, analog stick or keys input press state. */ bool InputStart; bool InputMap;`
`bool`	`InputLeftThe following Press* boolean values return true if the player activated the corresponding button, analog stick, or key this frame. Writing to this variable simulates the press or release of that referenced button, analog stick or keys input press state. */ bool InputStart; bool InputMap; bool InputUp;`
`bool`	`InputRightThe following Press* boolean values return true if the player activated the corresponding button, analog stick, or key this frame. Writing to this variable simulates the press or release of that referenced button, analog stick or keys input press state. */ bool InputStart; bool InputMap; bool InputUp; bool InputDown;`
`bool`	`InputAThe following Press* boolean values return true if the player activated the corresponding button, analog stick, or key this frame. Writing to this variable simulates the press or release of that referenced button, analog stick or keys input press state. */ bool InputStart; bool InputMap; bool InputUp; bool InputDown; bool InputLeft;`
`bool`	`InputBThe following Press* boolean values return true if the player activated the corresponding button, analog stick, or key this frame. Writing to this variable simulates the press or release of that referenced button, analog stick or keys input press state. */ bool InputStart; bool InputMap; bool InputUp; bool InputDown; bool InputLeft; bool InputRight;`
`bool`	`InputLThe following Press* boolean values return true if the player activated the corresponding button, analog stick, or key this frame. Writing to this variable simulates the press or release of that referenced button, analog stick or keys input press state. */ bool InputStart; bool InputMap; bool InputUp; bool InputDown; bool InputLeft; bool InputRight; bool InputA;`
`bool`	`InputRThe following Press* boolean values return true if the player activated the corresponding button, analog stick, or key this frame. Writing to this variable simulates the press or release of that referenced button, analog stick or keys input press state. */ bool InputStart; bool InputMap; bool InputUp; bool InputDown; bool InputLeft; bool InputRight; bool InputA; bool InputB;`
`bool`	InputAxisUpThe following Press* boolean values return true if the player activated the corresponding button, analog stick, or key this frame. Writing to this variable simulates the press or release of that referenced button, analog stick or keys input press state. */ bool InputStart; bool InputMap; bool InputUp; bool InputDown; bool InputLeft; bool InputRight; bool InputA; bool InputB; bool InputL; bool InputR; bool InputEx1 bool InputEx2 bool InputEx3
`bool`	InputAxisDownThe following Press* boolean values return true if the player activated the corresponding button, analog stick, or key this frame. Writing to this variable simulates the press or release of that referenced button, analog stick or keys input press state. */ bool InputStart; bool InputMap; bool InputUp; bool InputDown; bool InputLeft; bool InputRight; bool InputA; bool InputB; bool InputL; bool InputR; bool InputEx1 bool InputEx2 bool InputEx3 bool InputEx4
`bool`	InputAxisLeftThe following Press* boolean values return true if the player activated the corresponding button, analog stick, or key this frame. Writing to this variable simulates the press or release of that referenced button, analog stick or keys input press state. */ bool InputStart; bool InputMap; bool InputUp; bool InputDown; bool InputLeft; bool InputRight; bool InputA; bool InputB; bool InputL; bool InputR; bool InputEx1 bool InputEx2 bool InputEx3 bool InputEx4 bool InputAxisUp;
`bool`	InputAxisRightThe following Press* boolean values return true if the player activated the corresponding button, analog stick, or key this frame. Writing to this variable simulates the press or release of that referenced button, analog stick or keys input press state. */ bool InputStart; bool InputMap; bool InputUp; bool InputDown; bool InputLeft; bool InputRight; bool InputA; bool InputB; bool InputL; bool InputR; bool InputEx1 bool InputEx2 bool InputEx3 bool InputEx4 bool InputAxisUp; bool InputAxisDown;
`bool`	PressStartThe following Press* boolean values return true if the player activated the corresponding button, analog stick, or key this frame. Writing to this variable simulates the press or release of that referenced button, analog stick or keys input press state. */ bool InputStart; bool InputMap; bool InputUp; bool InputDown; bool InputLeft; bool InputRight; bool InputA; bool InputB; bool InputL; bool InputR; bool InputEx1 bool InputEx2 bool InputEx3 bool InputEx4 bool InputAxisUp; bool InputAxisDown; bool InputAxisLeft; bool InputAxisRight;
`bool`	PressMapThe following Press* boolean values return true if the player activated the corresponding button, analog stick, or key this frame. Writing to this variable simulates the press or release of that referenced button, analog stick or keys input press state. */ bool InputStart; bool InputMap; bool InputUp; bool InputDown; bool InputLeft; bool InputRight; bool InputA; bool InputB; bool InputL; bool InputR; bool InputEx1 bool InputEx2 bool InputEx3 bool InputEx4 bool InputAxisUp; bool InputAxisDown; bool InputAxisLeft; bool InputAxisRight;
`bool`	PressUpThe following Press* boolean values return true if the player activated the corresponding button, analog stick, or key this frame. Writing to this variable simulates the press or release of that referenced button, analog stick or keys input press state. */ bool InputStart; bool InputMap; bool InputUp; bool InputDown; bool InputLeft; bool InputRight; bool InputA; bool InputB; bool InputL; bool InputR; bool InputEx1 bool InputEx2 bool InputEx3 bool InputEx4 bool InputAxisUp; bool InputAxisDown; bool InputAxisLeft; bool InputAxisRight; bool PressStart;
`bool`	PressDownThe following Press* boolean values return true if the player activated the corresponding button, analog stick, or key this frame. Writing to this variable simulates the press or release of that referenced button, analog stick or keys input press state. */ bool InputStart; bool InputMap; bool InputUp; bool InputDown; bool InputLeft; bool InputRight; bool InputA; bool InputB; bool InputL; bool InputR; bool InputEx1 bool InputEx2 bool InputEx3 bool InputEx4 bool InputAxisUp; bool InputAxisDown; bool InputAxisLeft; bool InputAxisRight; bool PressStart; bool PressMap;
`bool`	PressLeftThe following Press* boolean values return true if the player activated the corresponding button, analog stick, or key this frame. Writing to this variable simulates the press or release of that referenced button, analog stick or keys input press state. */ bool InputStart; bool InputMap; bool InputUp; bool InputDown; bool InputLeft; bool InputRight; bool InputA; bool InputB; bool InputL; bool InputR; bool InputEx1 bool InputEx2 bool InputEx3 bool InputEx4 bool InputAxisUp; bool InputAxisDown; bool InputAxisLeft; bool InputAxisRight; bool PressStart; bool PressMap; bool PressUp;
`bool`	PressRightThe following Press* boolean values return true if the player activated the corresponding button, analog stick, or key this frame. Writing to this variable simulates the press or release of that referenced button, analog stick or keys input press state. */ bool InputStart; bool InputMap; bool InputUp; bool InputDown; bool InputLeft; bool InputRight; bool InputA; bool InputB; bool InputL; bool InputR; bool InputEx1 bool InputEx2 bool InputEx3 bool InputEx4 bool InputAxisUp; bool InputAxisDown; bool InputAxisLeft; bool InputAxisRight; bool PressStart; bool PressMap; bool PressUp; bool PressDown;
`bool`	PressAThe following Press* boolean values return true if the player activated the corresponding button, analog stick, or key this frame. Writing to this variable simulates the press or release of that referenced button, analog stick or keys input press state. */ bool InputStart; bool InputMap; bool InputUp; bool InputDown; bool InputLeft; bool InputRight; bool InputA; bool InputB; bool InputL; bool InputR; bool InputEx1 bool InputEx2 bool InputEx3 bool InputEx4 bool InputAxisUp; bool InputAxisDown; bool InputAxisLeft; bool InputAxisRight; bool PressStart; bool PressMap; bool PressUp; bool PressDown; bool PressLeft;
`bool`	PressBThe following Press* boolean values return true if the player activated the corresponding button, analog stick, or key this frame. Writing to this variable simulates the press or release of that referenced button, analog stick or keys input press state. */ bool InputStart; bool InputMap; bool InputUp; bool InputDown; bool InputLeft; bool InputRight; bool InputA; bool InputB; bool InputL; bool InputR; bool InputEx1 bool InputEx2 bool InputEx3 bool InputEx4 bool InputAxisUp; bool InputAxisDown; bool InputAxisLeft; bool InputAxisRight; bool PressStart; bool PressMap; bool PressUp; bool PressDown; bool PressLeft; bool PressRight;
`bool`	PressLThe following Press* boolean values return true if the player activated the corresponding button, analog stick, or key this frame. Writing to this variable simulates the press or release of that referenced button, analog stick or keys input press state. */ bool InputStart; bool InputMap; bool InputUp; bool InputDown; bool InputLeft; bool InputRight; bool InputA; bool InputB; bool InputL; bool InputR; bool InputEx1 bool InputEx2 bool InputEx3 bool InputEx4 bool InputAxisUp; bool InputAxisDown; bool InputAxisLeft; bool InputAxisRight; bool PressStart; bool PressMap; bool PressUp; bool PressDown; bool PressLeft; bool PressRight; bool PressA;
`bool`	PressRThe following Press* boolean values return true if the player activated the corresponding button, analog stick, or key this frame. Writing to this variable simulates the press or release of that referenced button, analog stick or keys input press state. */ bool InputStart; bool InputMap; bool InputUp; bool InputDown; bool InputLeft; bool InputRight; bool InputA; bool InputB; bool InputL; bool InputR; bool InputEx1 bool InputEx2 bool InputEx3 bool InputEx4 bool InputAxisUp; bool InputAxisDown; bool InputAxisLeft; bool InputAxisRight; bool PressStart; bool PressMap; bool PressUp; bool PressDown; bool PressLeft; bool PressRight; bool PressA; bool PressB;
`bool`	PressAxisUpThe following Press* boolean values return true if the player activated the corresponding button, analog stick, or key this frame. Writing to this variable simulates the press or release of that referenced button, analog stick or keys input press state. */ bool InputStart; bool InputMap; bool InputUp; bool InputDown; bool InputLeft; bool InputRight; bool InputA; bool InputB; bool InputL; bool InputR; bool InputEx1 bool InputEx2 bool InputEx3 bool InputEx4 bool InputAxisUp; bool InputAxisDown; bool InputAxisLeft; bool InputAxisRight; bool PressStart; bool PressMap; bool PressUp; bool PressDown; bool PressLeft; bool PressRight; bool PressA; bool PressB; bool PressL; bool PressR; bool PressEx1 bool PressEx2 bool PressEx3
`bool`	PressAxisDownThe following Press* boolean values return true if the player activated the corresponding button, analog stick, or key this frame. Writing to this variable simulates the press or release of that referenced button, analog stick or keys input press state. */ bool InputStart; bool InputMap; bool InputUp; bool InputDown; bool InputLeft; bool InputRight; bool InputA; bool InputB; bool InputL; bool InputR; bool InputEx1 bool InputEx2 bool InputEx3 bool InputEx4 bool InputAxisUp; bool InputAxisDown; bool InputAxisLeft; bool InputAxisRight; bool PressStart; bool PressMap; bool PressUp; bool PressDown; bool PressLeft; bool PressRight; bool PressA; bool PressB; bool PressL; bool PressR; bool PressEx1 bool PressEx2 bool PressEx3 bool PressEx4
`bool`	PressAxisLeftThe following Press* boolean values return true if the player activated the corresponding button, analog stick, or key this frame. Writing to this variable simulates the press or release of that referenced button, analog stick or keys input press state. */ bool InputStart; bool InputMap; bool InputUp; bool InputDown; bool InputLeft; bool InputRight; bool InputA; bool InputB; bool InputL; bool InputR; bool InputEx1 bool InputEx2 bool InputEx3 bool InputEx4 bool InputAxisUp; bool InputAxisDown; bool InputAxisLeft; bool InputAxisRight; bool PressStart; bool PressMap; bool PressUp; bool PressDown; bool PressLeft; bool PressRight; bool PressA; bool PressB; bool PressL; bool PressR; bool PressEx1 bool PressEx2 bool PressEx3 bool PressEx4 bool PressAxisUp;
`bool`	PressAxisRightThe following Press* boolean values return true if the player activated the corresponding button, analog stick, or key this frame. Writing to this variable simulates the press or release of that referenced button, analog stick or keys input press state. */ bool InputStart; bool InputMap; bool InputUp; bool InputDown; bool InputLeft; bool InputRight; bool InputA; bool InputB; bool InputL; bool InputR; bool InputEx1 bool InputEx2 bool InputEx3 bool InputEx4 bool InputAxisUp; bool InputAxisDown; bool InputAxisLeft; bool InputAxisRight; bool PressStart; bool PressMap; bool PressUp; bool PressDown; bool PressLeft; bool PressRight; bool PressA; bool PressB; bool PressL; bool PressR; bool PressEx1 bool PressEx2 bool PressEx3 bool PressEx4 bool PressAxisUp; bool PressAxisDown;
`int`	`InputMouseXThe mouse's in-game X position. This value is undefined if the mouse pointer is outside the Zelda Classic window.`
`int`	`InputMouseYThe mouse's in-game Y position. This value is undefined if the mouse pointer is outside the Zelda Classic window.`
`int`	`InputMouseBWhether the left or right mouse buttons are pressed, as two flags OR'd (\|) together; use the MB_ constants or the Input'X'Click functions in std.zh to check the button states. InputMouseB is read only; while setting it is not syntactically incorrect, it does nothing If you are not comfortable with binary, you can use the InputMouse'x' functions in std.zh`
`int`	`InputMouseZThe current state of the mouse's scroll wheel, negative for scrolling down and positive for scrolling up.`
`bool`	`Item[]True if Link's inventory contains the item whose ID is the index of the array access. Use the I_ constants in std.zh as an index into this array.`
`int`	`EquipmentContains the item IDs of what is currently equiped to Link's A and B buttons. The first 8 bits contain the A button item, and the second 8 bits contain the B button item. Currently it is only possible to retrieve this value and not to set it. If you are not comfortable with performing binary operations you can use the GetLinkEquipment'X' functions from std.zh.`
`int`	`TileThe current tile associated with Link. The effect of writing to this variable is undefined. Because Link's tile is not determined until he is drawn, this will actually represent Link's tile in the previous frame.`
`int`	`FlipThe current tile associated with Link. The effect of writing to this variable is undefined. Because Link's tile is not determined until he is drawn, this will actually represent Link's tile flip in the previous frame.`
`int`	`HitZHeightThe Z-axis height of Link's hitbox, or collision rectangle. The lower it is, the lower a flying or jumping enemy must fly in order to hit Link. Writing to this is ignored unless Extend is set to values >=3.`
`int`	`HitXOffsetThe X offset of Link's hitbox, or collision rectangle. Setting it to positive or negative values will move Link's hitbox left or right. Writing to this is ignored unless Extend is set to values >=3.`
`int`	`HitYOffsetThe Y offset of Link's hitbox, or collision rectangle. Setting it to positive or negative values will move Link's hitbox up or down. Writing to this is ignored unless Extend is set to values >=3.`
`int`	`DrawXOffsetThe X offset of Link's sprite. Setting it to positive or negative values will move the sprite's tiles left or right relative to its position. Writing to this is ignored unless Extend is set to values >=3.`
`int`	`DrawYOffsetThe Y offset of Link's sprite. Setting it to positive or negative values will move the sprite's tiles up or down relative to its position. Writing to this is ignored unless Extend is set to values >=3.`
`int`	`DrawZOffsetThe Z offset of Link's sprite. Writing to this is ignored unless Extend is set to values >=3.`
`float`	`Misc[]An array of 16 miscellaneous variables for you to use as you please. These variables are not saved with Link.`
`void`	`Warp(int DMap, int screen)Warps link to the given screen in the given DMap, just like if he'd triggered an 'Insta-Warp'-type warp.`
`void`	`PitWarp(int DMap, int screen)This is identical to Warp, but Link's X and Y positions are preserved when he enters the destination screen, rather than being set to the Warp Return square.`
`void`	`SelectAWeapon(int dir)Sets the A button item to the next one in the given direction based on the indices set in the subscreen. This will skip over items if A and B would be set to the same item. If the quest rule "Can Select A-Button Weapon On Subscreen" is disabled, this function does nothing.`
`void`	`SelectBWeapon(int dir)Sets the B button item to the next one in the given direction based on the indices set in the subscreen. This will skip over items if A and B would be set to the same item.`